Call Endpoint (RTSA)
(Admin Tools)
Synopsis
This operator allows you call the endpoint of a deployed process in a RapidMiner Real-Time Scoring Agent (RTSA) deployment.Description
This operator allows you call the endpoint of a deployed process in a RapidMiner Real-Time Scoring Agent (RTSA) deployment by querying its unique endpoint URL and injecting any parameters as needed. If the query is successful, the resulting ExampleSet contains the same information as if the process were run locally on Studio. If the query is not successful, the resulting ExampleSet contains information about the error.
As with other operators in this extension, the input of this operator requires an RTSA Connection IOObject with the RTSA URL and credentials (user_name and password, if basic_authis selected in the authentication field) if needed to access the RTSA API. You can create an RTSA connection IOObject in Studio by going to Create Connections selection in the Connections menu and selecting 'RTSA' as the Connection Type. A user_name and password can be obtained by logging to the AI Hub as an administrator in the web interface and, under 'Admin Tools', going to 'Platform Administration'. Once in this module, select 'Scoring Access Control' from the sidebar and enter the appropriate information in the 'Add new user to the scoring service' section.
Input
rtsa_connection (Connection)An RTSA Connection IOObject.
exa (Data table)An ExampleSet to be used as input for the RTSA process.
Output
- exa (Data table)
An ExampleSet containing data returned by the deployed process.
- rtsa_connection (Connection)
The RTSA Connection IOObject from the input port, delivered as a passthru.
Parameters
- deployment_name The name of the deployment. Range:
- process_name The name of the process. Range:
- fail_on_error If set to true and the process does not run successfully, the operator will fail with an error. If set to false and the process does not run successfully, the operator will run but return nothing. Range:
- use_input_meta_data If set to true the metadata of the input data set will be delivered to the output port. If set to false the operator will return 'dummy' metadata. You can manually set the metadata by using the Set Meta Data operator (part of the Operator Toolbox extension). Range:
- query_parameters Accepts to set query parameters and their values which will get added to the request made to the RTSA. Range: